home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / MPI_Constants.z / MPI_Constants
Encoding:
Text File  |  2002-10-03  |  16.4 KB  |  331 lines
  1.  
  2.  
  3.  
  4. MMMMPPPPIIII____CCCCOOOONNNNSSSSTTTTAAAANNNNTTTTSSSS((((3333))))                                              MMMMPPPPIIII____CCCCOOOONNNNSSSSTTTTAAAANNNNTTTTSSSS((((3333))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      MMMMPPPPIIII____CCCCoooonnnnssssttttaaaannnnttttssss - Defines constants
  10.  
  11. SSSSTTTTAAAANNNNDDDDAAAARRRRDDDDSSSS
  12.      This release implements the MPI 1.2 standard, as documented by the MPI
  13.      Forum in the spring 1997 release of _M_P_I:  _A _M_e_s_s_a_g_e _P_a_s_s_i_n_g _I_n_t_e_r_f_a_c_e
  14.      _S_t_a_n_d_a_r_d.
  15.  
  16. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  17.      The MMMMPPPPIIII____CCCCoooonnnnssssttttaaaannnnttttssss routine defines constants of the following types:
  18.  
  19.      *   Communicators
  20.  
  21.      *   Groups
  22.  
  23.      *   Results of compare operations
  24.  
  25.      *   Collective operations
  26.  
  27.      *   Permanent key values
  28.  
  29.      *   Null objects
  30.  
  31.      *   Predefined constants
  32.  
  33.      *   Topology types
  34.  
  35.      *   MPI status
  36.  
  37.      *   Special MPI types and functions
  38.  
  39.    CCCCoooommmmmmmmuuuunnnniiiiccccaaaattttoooorrrrssss
  40.      The following communicator constants are of type MMMMPPPPIIII____CCCCoooommmmmmmm in C and type
  41.      integer in Fortran:
  42.  
  43.      MMMMPPPPIIII____CCCCOOOOMMMMMMMM____WWWWOOOORRRRLLLLDDDD      Specifies a constant that contains all of the
  44.                          processes
  45.  
  46.      MMMMPPPPIIII____CCCCOOOOMMMMMMMM____SSSSEEEELLLLFFFF       Specifies a constant that contains only the calling
  47.                          process
  48.  
  49.    GGGGrrrroooouuuuppppssss
  50.      The following group constant is of type MMMMPPPPIIII____GGGGrrrroooouuuupppp in C and type integer
  51.      in Fortran:
  52.  
  53.      MMMMPPPPIIII____GGGGRRRROOOOUUUUPPPP____EEEEMMMMPPPPTTTTYYYY     Specifies a group that contains no members
  54.  
  55.    CCCCoooommmmppppaaaarrrreeee OOOOppppeeeerrrraaaattttiiiioooonnnn RRRReeeessssuuuullllttttssss
  56.      The following constants specify results of compare operations:
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. MMMMPPPPIIII____CCCCOOOONNNNSSSSTTTTAAAANNNNTTTTSSSS((((3333))))                                              MMMMPPPPIIII____CCCCOOOONNNNSSSSTTTTAAAANNNNTTTTSSSS((((3333))))
  71.  
  72.  
  73.  
  74.      MMMMPPPPIIII____IIIIDDDDEEEENNNNTTTT           The groups are identical.
  75.  
  76.      MMMMPPPPIIII____CCCCOOOONNNNGGGGRRRRUUUUEEEENNNNTTTT       The groups are identical (used only for
  77.                          MMMMPPPPIIII____CCCCoooommmmmmmm____ccccoooommmmppppaaaarrrreeee(3)).
  78.  
  79.      MMMMPPPPIIII____SSSSIIIIMMMMIIIILLLLAAAARRRR         The groups contain the same members, but in a
  80.                          different order.
  81.  
  82.      MMMMPPPPIIII____UUUUNNNNEEEEQQQQUUUUAAAALLLL         The groups are not equal.
  83.  
  84.    CCCCoooolllllllleeeeccccttttiiiivvvveeee OOOOppppeeeerrrraaaattttiiiioooonnnnssss
  85.      The collective combination operations (MMMMPPPPIIII____RRRReeeedddduuuucccceeee(3), MMMMPPPPIIII____AAAAllllllllrrrreeeedddduuuucccceeee(3),
  86.      MMMMPPPPIIII____RRRReeeedddduuuucccceeee____ssssccccaaaatttttttteeeerrrr(3), and MMMMPPPPIIII____SSSSccccaaaannnn(3)) take a combination operation.
  87.      This combination operation is of type MMMMPPPPIIII____OOOOpppp in C and of type integer in
  88.      Fortran.  The predefined operations are as follows:
  89.  
  90.      MMMMPPPPIIII____MMMMAAAAXXXX             Returns the maximum value
  91.  
  92.      MMMMPPPPIIII____MMMMIIIINNNN             Returns the minumum value
  93.  
  94.      MMMMPPPPIIII____SSSSUUUUMMMM             Returns the sum
  95.  
  96.      MMMMPPPPIIII____PPPPRRRROOOODDDD            Returns the product
  97.  
  98.      MMMMPPPPIIII____LLLLAAAANNNNDDDD            Returns the logical AND
  99.  
  100.      MMMMPPPPIIII____BBBBAAAANNNNDDDD            Returns the bitwise AND
  101.  
  102.      MMMMPPPPIIII____LLLLOOOORRRR             Returns the logical OR
  103.  
  104.      MMMMPPPPIIII____BBBBOOOORRRR             Returns the bitwise OR
  105.  
  106.      MMMMPPPPIIII____LLLLXXXXOOOORRRR            Returns the logical exclusive OR
  107.  
  108.      MMMMPPPPIIII____BBBBXXXXOOOORRRR            Returns the bitwise exclusive OR
  109.  
  110.      MMMMPPPPIIII____MMMMIIIINNNNLLLLOOOOCCCC          Returns the minimum value and the location (actually,
  111.                          it returns the value of the second element of the
  112.                          structure where the minimum of the first element is
  113.                          found)
  114.  
  115.      MMMMPPPPIIII____MMMMAAAAXXXXLLLLOOOOCCCC          Returns the maximum value and the location
  116.  
  117.    PPPPeeeerrrrmmmmaaaannnneeeennnntttt KKKKeeeeyyyy VVVVaaaalllluuuueeeessss
  118.      The types of the following permanent key value constants are the same in
  119.      C and Fortran:
  120.  
  121.      MMMMPPPPIIII____TTTTAAAAGGGG____UUUUBBBB               Specifies largest tag value
  122.  
  123.      MMMMPPPPIIII____HHHHOOOOSSSSTTTT                 Specifies the rank of the process that is host,
  124.                               if any
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. MMMMPPPPIIII____CCCCOOOONNNNSSSSTTTTAAAANNNNTTTTSSSS((((3333))))                                              MMMMPPPPIIII____CCCCOOOONNNNSSSSTTTTAAAANNNNTTTTSSSS((((3333))))
  137.  
  138.  
  139.  
  140.      MMMMPPPPIIII____IIIIOOOO                   Specifies the rank of the process that can
  141.                               perform I/O operations
  142.  
  143.      MMMMPPPPIIII____WWWWTTTTIIIIMMMMEEEE____IIIISSSS____GGGGLLLLOOOOBBBBAAAALLLL      Has a value of 1 if MMMMPPPPIIII____WWWWttttiiiimmmmeeee(3) is globally
  144.                               synchronized
  145.  
  146.    NNNNuuuullllllll OOOObbbbjjjjeeeeccccttttssss
  147.      The following constants specify null objects:
  148.  
  149.      MMMMPPPPIIII____CCCCOOOOMMMMMMMM____NNNNUUUULLLLLLLL            Specifies a null communicator
  150.  
  151.      MMMMPPPPIIII____OOOOPPPP____NNNNUUUULLLLLLLL              Specifies a null operation
  152.  
  153.      MMMMPPPPIIII____GGGGRRRROOOOUUUUPPPP____NNNNUUUULLLLLLLL           Specifies a null group
  154.  
  155.      MMMMPPPPIIII____DDDDAAAATTTTAAAATTTTYYYYPPPPEEEE____NNNNUUUULLLLLLLL        Specifies a null data type
  156.  
  157.      MMMMPPPPIIII____RRRREEEEQQQQUUUUEEEESSSSTTTT____NNNNUUUULLLLLLLL         Specifies a null request
  158.  
  159.      MMMMPPPPIIII____EEEERRRRRRRRHHHHAAAANNNNDDDDLLLLEEEERRRR____NNNNUUUULLLLLLLL      Specifies a null error handler
  160.  
  161.    PPPPrrrreeeeddddeeeeffffiiiinnnneeeedddd CCCCoooonnnnssssttttaaaannnnttttssss
  162.      The following constants are predefined:
  163.  
  164.      MMMMPPPPIIII____MMMMAAAAXXXX____PPPPRRRROOOOCCCCEEEESSSSSSSSOOOORRRR____NNNNAAAAMMMMEEEE        Specifies the maximum length of the name
  165.                                    returned by MMMMPPPPIIII____GGGGeeeetttt____pppprrrroooocccceeeessssssssoooorrrr____nnnnaaaammmmeeee(3)
  166.  
  167.      MMMMPPPPIIII____MMMMAAAAXXXX____EEEERRRRRRRROOOORRRR____SSSSTTTTRRRRIIIINNNNGGGG          Specifies the maximum length of the string
  168.                                    returned by MMMMPPPPIIII____EEEErrrrrrrroooorrrr____ssssttttrrrriiiinnnngggg(3)
  169.  
  170.      MMMMPPPPIIII____UUUUNNNNDDDDEEEEFFFFIIIINNNNEEEEDDDD                 Used by many routines to indicate an
  171.                                    undefined or unknown integer value
  172.  
  173.      MMMMPPPPIIII____UUUUNNNNDDDDEEEEFFFFIIIINNNNEEEEDDDD____RRRRAAAANNNNKKKK            Specifies an unknown rank
  174.  
  175.      MMMMPPPPIIII____KKKKEEEEYYYYVVVVAAAALLLL____IIIINNNNVVVVAAAALLLLIIIIDDDD            Provides a special key value that can be
  176.                                    used to detect uninitialized key values
  177.  
  178.      MMMMPPPPIIII____BBBBSSSSEEEENNNNDDDD____OOOOVVVVEEEERRRRHHHHEEEEAAAADDDD            Specifies a value that can be added to the
  179.                                    size of a MMMMPPPPIIII____BBBBsssseeeennnndddd(3) buffer for each
  180.                                    outstanding message
  181.  
  182.      MMMMPPPPIIII____PPPPRRRROOOOCCCC____NNNNUUUULLLLLLLL                 Specifies a rank that can be used to send
  183.                                    or receive from nnnnoooo----oooonnnneeee
  184.  
  185.      MMMMPPPPIIII____AAAANNNNYYYY____SSSSOOOOUUUURRRRCCCCEEEE                Indicates, in a receive, to accept a
  186.                                    message from aaaannnnyyyyoooonnnneeee
  187.  
  188.      MMMMPPPPIIII____AAAANNNNYYYY____TTTTAAAAGGGG                   Indicates, in a receive, to accept a
  189.                                    message with any tag value
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. MMMMPPPPIIII____CCCCOOOONNNNSSSSTTTTAAAANNNNTTTTSSSS((((3333))))                                              MMMMPPPPIIII____CCCCOOOONNNNSSSSTTTTAAAANNNNTTTTSSSS((((3333))))
  203.  
  204.  
  205.  
  206.      MMMMPPPPIIII____BBBBOOOOTTTTTTTTOOOOMMMM                    Can be used to indicate the bottom of the
  207.                                    address space
  208.  
  209.    TTTTooooppppoooollllooooggggyyyy TTTTyyyyppppeeeessss
  210.      The following constants are topology types:
  211.  
  212.      MMMMPPPPIIII____GGGGRRRRAAAAPPPPHHHH      Indicates a general graph
  213.  
  214.      MMMMPPPPIIII____CCCCAAAARRRRTTTT       Indicates a Cartesian grid
  215.  
  216.    MMMMPPPPIIII SSSSttttaaaattttuuuussss
  217.      The MMMMPPPPIIII____SSSSttttaaaattttuuuussss data type is a structure.  The elements that programmers
  218.      can use are as follows:
  219.  
  220.      MMMMPPPPIIII____SSSSOOOOUUUURRRRCCCCEEEE     Indicates who sent the message
  221.  
  222.      MMMMPPPPIIII____TTTTAAAAGGGG        Indicates with what tag the message was sent
  223.  
  224.      MMMMPPPPIIII____EEEERRRRRRRROOOORRRR      Indicates any error return
  225.  
  226.    SSSSppppeeeecccciiiiaaaallll MMMMPPPPIIII TTTTyyyyppppeeeessss aaaannnndddd FFFFuuuunnnnccccttttiiiioooonnnnssss
  227.      The following constants are special MPI types and functions:
  228.  
  229.      MMMMPPPPIIII____AAAAiiiinnnntttt                      Specifies a C type that holds any valid
  230.                                    address
  231.  
  232.      MMMMPPPPIIII____HHHHaaaannnnddddlllleeeerrrr____ffffuuuunnnnccccttttiiiioooonnnn          Specifies a C function for handling errors
  233.                                    (see the MMMMPPPPIIII____EEEErrrrrrrrhhhhaaaannnnddddlllleeeerrrr____ccccrrrreeeeaaaatttteeee(3) man page)
  234.  
  235.      MMMMPPPPIIII____UUUUsssseeeerrrr____ffffuuuunnnnccccttttiiiioooonnnn             Specifies a C function to combine values
  236.                                    (see the Collective Operations subsection
  237.                                    on this man page) and the MMMMPPPPIIII____OOOOpppp____ccccrrrreeeeaaaatttteeee(3)
  238.                                    man page)
  239.  
  240.      MMMMPPPPIIII____CCCCooooppppyyyy____ffffuuuunnnnccccttttiiiioooonnnn             Specifies a function to copy attributes
  241.                                    (see the MMMMPPPPIIII____KKKKeeeeyyyyvvvvaaaallll____ccccrrrreeeeaaaatttteeee(3) man page)
  242.  
  243.      MMMMPPPPIIII____DDDDeeeelllleeeetttteeee____ffffuuuunnnnccccttttiiiioooonnnn           Specifies a function to delete attributes
  244.                                    (see the MMMMPPPPIIII____KKKKeeeeyyyyvvvvaaaallll____ccccrrrreeeeaaaatttteeee(3) man page)
  245.  
  246.      MMMMPPPPIIII____EEEERRRRRRRROOOORRRRSSSS____AAAARRRREEEE____FFFFAAAATTTTAAAALLLL          Specifies an error handler that forces an
  247.                                    exit on error
  248.  
  249.      MMMMPPPPIIII____EEEERRRRRRRROOOORRRRSSSS____RRRREEEETTTTUUUURRRRNNNN             Specifies an error handler that returns
  250.                                    error codes (as a value of the MPI routine
  251.                                    in C and through the last argument in
  252.                                    Fortran)
  253.  
  254. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  255.      MMMMPPPPIIII____AAAAllllllllrrrreeeedddduuuucccceeee(3), MMMMPPPPIIII____BBBBsssseeeennnndddd(3), MMMMPPPPIIII____CCCCoooommmmmmmm____ccccoooommmmppppaaaarrrreeee(3),
  256.      MMMMPPPPIIII____EEEErrrrrrrrhhhhaaaannnnddddlllleeeerrrr____ccccrrrreeeeaaaatttteeee(3), MMMMPPPPIIII____EEEErrrrrrrroooorrrr____ssssttttrrrriiiinnnngggg(3), MMMMPPPPIIII____GGGGeeeetttt____pppprrrroooocccceeeessssssssoooorrrr____nnnnaaaammmmeeee(3),
  257.      MMMMPPPPIIII____KKKKeeeeyyyyvvvvaaaallll____ccccrrrreeeeaaaatttteeee(3), MMMMPPPPIIII____OOOOpppp____ccccrrrreeeeaaaatttteeee(3), MMMMPPPPIIII____RRRReeeedddduuuucccceeee(3),
  258.  
  259.  
  260.  
  261.                                                                         PPPPaaaaggggeeee 4444
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268. MMMMPPPPIIII____CCCCOOOONNNNSSSSTTTTAAAANNNNTTTTSSSS((((3333))))                                              MMMMPPPPIIII____CCCCOOOONNNNSSSSTTTTAAAANNNNTTTTSSSS((((3333))))
  269.  
  270.  
  271.  
  272.      MMMMPPPPIIII____RRRReeeedddduuuucccceeee____ssssccccaaaatttttttteeeerrrr(3), MMMMPPPPIIII____SSSSccccaaaannnn(3), MMMMPPPPIIII____WWWWttttiiiimmmmeeee(3)
  273.  
  274.  
  275.  
  276.  
  277.  
  278.  
  279.  
  280.  
  281.  
  282.  
  283.  
  284.  
  285.  
  286.  
  287.  
  288.  
  289.  
  290.  
  291.  
  292.  
  293.  
  294.  
  295.  
  296.  
  297.  
  298.  
  299.  
  300.  
  301.  
  302.  
  303.  
  304.  
  305.  
  306.  
  307.  
  308.  
  309.  
  310.  
  311.  
  312.  
  313.  
  314.  
  315.  
  316.  
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327.                                                                         PPPPaaaaggggeeee 5555
  328.  
  329.  
  330.  
  331.